Registration
Description
A Registration message is generated when a patient is checked into a specific visit or registered for a Hospital Outpatient Visit. This event type typically includes information about the patient, such as demographics details, insurance information, and visit specifics, such as the reason for the visit, planned procedures, and relevant medical history.
API endpoints for Patient Registration
Sync REST API Endpoint to call the API: https://{base_url}/api/v1/patient-admin/registration.
Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.
Data Model JSON for Registration
Registration - Sample Payload
{
"Meta": {
"DataModel": "PatientAdmin",
"EventType": "Registration",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"Source": {
"ID": "72112631-2a05-4ad1-9c10-a91edfe55e2d ",
"Name": "EHR Bridge Dev Tools"
},
"Destinations": [
{
"ID": "50d20ac8-0c29-4c7a-99ef-04a7e6e78830",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "5773c3b1-70ad-4b39-a942-dc6ce4ccfaa6 ",
"AttemptID": "bfce091a-e32e-42a5-99d3-bcd77771e4d7 "
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "43da39b3-6308-4084-80ff-007848895c34 ",
"IDType": "EHRID"
},
{
"ID": "a9912414-4231-4dd8-b21a-c8a85d29b0d5",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "John",
"MiddleName": "Henry",
"LastName": "Franklin",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18067675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "567 Austin Way",
"City": "San Jose"",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
}
},
"Notes": [],
"Contacts": [
{
"FirstName": "Sara",
"MiddleName": null,
"LastName": "Franklin",
"Address": {
"StreetAddress": "567 Austin Way",
"City": "San Jose"",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": {
"Home": "+18088675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"RelationToPatient": "Mother",
"EmailAddresses": [
"sara.f@test.net"
],
"Roles": [
"Emergency Contact"
]
}
],
"Diagnoses": [
{
"Code": "R07.0",
"Codeset": "ICD-10",
"Name": "Throat infection",
"Type": null,
"DocumentedDateTime": null
}
],
"Allergies": [
{
"Code": "7982",
"Codeset": "RxNorm",
"Name": "Penicillin-II",
"Type": {
"Code": null,
"Codeset": null,
"Name": null
},
"OnsetDateTime": null,
"Reaction": [
{
"Code": "28926001",
"Codeset": "SNOMED CT",
"Name": "Rash"
},
{
"Code": "247472004",
"Codeset": "SNOMED CT",
"Name": "Hives"
}
],
"Severity": {
"Code": null,
"Codeset": null,
"Name": null
},
"Status": null
}
],
"PCP": {
"NPI": "4356789876",
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Davis",
"LastName": "Wilson",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "San Jose",
"State": "CA",
"ZIP": "53703",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
}
},
"Visit": {
"VisitNumber": "1234",
"AccountNumber": null,
"PatientClass": "Inpatient",
"VisitDateTime": "2022-08-16T14:21:21.506Z",
"Duration": 15,
"Reason": "Check up",
"Instructions": [],
"Balance": null,
"DiagnosisRelatedGroup": null,
"DiagnosisRelatedGroupType": null,
"AttendingProvider": {
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Davis",
"LastName": "Wilson",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "San Jose"",
"State": "CA",
"ZIP": "53703",
"County": "Santa Clara",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ConsultingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"AdmittingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"Department": null,
"Room": null
}
},
"AdditionalStaff": [],
"Location": {
"Type": "Inpatient",
"Facility": "MGM Hospital",
"Department": "3N",
"Room": "136",
"Bed": "B",
"Address": {
"StreetAddress": "987 Cross Ln",
"City": "San Jose"",
"State": "CA",
"ZIP": "53719",
"County": "Santa Clara",
"Country": "USA"
}
},
"Guarantor": {
"Number": "10001910",
"FirstName": "Kent",
"MiddleName": null,
"LastName": "Allen",
"SSN": null,
"DOB": null,
"Sex": null,
"Spouse": {
"FirstName": "Gracy",
"LastName": "Allen"
},
"Address": {
"StreetAddress": "678 Austin Way",
"City": "San Jose"",
"State": "CA",
"ZIP": "53566",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": {
"Home": null,
"Business": null,
"Mobile": null
},
"EmailAddresses": [],
"Type": null,
"RelationToPatient": "Father",
"Employer": {
"Name": "Digitech Labs",
"Address": {
"StreetAddress": "1456 Old Mary Road",
"City": "San Jose"",
"State": "CA",
"ZIP": "53719",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": "+18083451121"
}
},
"Insurances": [
{
"Plan": {
"ID": "31572",
"IDType": "Payor ID",
"Name": "HMO Plan",
"Type": null
},
"MemberNumber": null,
"Company": {
"ID": "60054",
"IDType": null,
"Name": "aetna (60054 0131)",
"Address": {
"StreetAddress": "PO Box 14080",
"City": "San Jose"",
"State": "CA",
"ZIP": "40512-4079",
"County": "Santa Clara",
"Country": "USA"
},
"PhoneNumber": "+18089541123"
},
"GroupNumber": "847025-024-0009",
"GroupName": "Digitech Labs",
"EffectiveDate": "2015-01-01",
"ExpirationDate": "2020-12-31",
"PolicyNumber": "9140860055",
"Priority": null,
"AgreementType": null,
"CoverageType": null,
"Insured": {
"Identifiers": [],
"LastName": null,
"MiddleName": null,
"FirstName": null,
"SSN": null,
"Relationship": null,
"DOB": null,
"Sex": null,
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
}
}
}
]
}
}